api/customers/{id} (Get)

Get	api/customers/{id}

In This Topic

Resource Path: /sites/{company-id}/api/customers/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/customers/{id}

Description

Retrieves a single Customer object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of a Customer as a Guid.	string

200 Response

The response body is of type Customer.

Returns a comprehensive Customer object.

Overview

Customer

Represents a comprehensive Customer record within the OnTime API.

PriceSets : Array[]

The collection of unique Guid identifiers referencing all PriceSet records assigned to this Customer.

DefaultPriceSet : string

The unique Guid identifier referencing the default PriceSet record assigned to this Customer.

Departments : Array[Department]

The collection of comprehensive Department records belonging to this Customer.

ID : string

The unique identifier of this Department.

CustomerID : string

The unique identifier of the Customer associated with this Department.

Name : string

The name assigned to this Department.

Contacts : Array[Contact]

The collection of comprehensive Contact records belonging to this Customer.

ID : string

The unique identifier of this Contact.

CustomerID : string

The unique identifier of the Customer associated with this Contact.

Name : string

The name assigned to this Contact.

Email : string

The email address assigned to this Contact.

Phone : string

The phone number assigned to this Contact.

ID : string

The unique identifier for this Customer record.

Name : string

The name of this Customer.

PrimaryContactName : string

The primary contact name of this Customer.

AddressLine1 : string

The street address of this Customer.

AddressLine2 : string

Additional secondary information related to this Customer's steet address.

City : string

The city or locality this Customer resides within.

State : string

The state, province, or other civil entity this Customer resides within.

PostalCode : string

The assigned postal code this Customer resides within.

Country : string

The country or other national political entity this Customer resides within.

Phone : string

The phone number assigned to this Customer.

Fax : string

The fax number assigned to this Customer.

Email : string

The email address assigned to this Customer.

Website : string

The website URL associated with this Customer.

AccountNumber : string

The account number assigned to this Customer.

DestinationCategories : string

The user-defined category assigned to this Customer.

BillingAdjustmentPercentage : number

The billing adjustment percentage assigned to this Customer.

SendInvoiceByEmail : boolean

The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via email.

SendInvoiceByPostal : boolean

The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via post (i.e. postal services, physical mail, snail mail, etc.).

SendInvoiceByFax : boolean

The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via fax.

HasWebPortalAccess : boolean

Determines if this Customer is authorized to log-in to the Customer Web Portal.

BillingEmail : string

The billing-specific email address assigned to this Customer.

TimeZone : string

The time zone this Customer resides within.

ReferenceNumber : string

The reference number assigned to this Customer.

PurchaseOrderNumber : string

The purchase order number assigned to this Customer.

Comments : string

Any additional comments associated with this Customer.

OrderEntryRequiredFields : string

Defines the required fields this Customer must provide when submitting a new {OnTime.Extensions.SDK.Order} through the Customer Web Portal.

Inactive : boolean

The active status of this Customer.

PricingMethod : string

The pricing method assigned to this Customer. Available Values: [None, ZoneToZone, Distance, FlatRate]

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.